package org.maxgroundstation.groundstation.view.map;

import java.awt.Graphics2D;

/**
 * An interface for map display overlays.
 * @author Scott Davis
 * 
 * Copyright (C) 2010  Scott Davis
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
public interface MapOverlay {

    /**
     * Draws the overlay on the map.
     * @param g2d the graphics 2D context.
     * @param currentLoc the current GPS location.
     * @param width the width of the map.
     * @param height the height of the map.
     * @param zoom the zoom level (m/pixel).
     */
    public void drawMapOverlay(String baseMapStyle, Graphics2D g2d, GpsLocation currentLoc, int width, 
            int height, float zoom);
    
    /**
     * Checks if the map overlay should be moved when map is dragged.
     * @return true if draggable.
     */
    public boolean isDraggable();
}